home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 3: Developer Tools / Linux Cubed Series 3 - Developer Tools.iso / devel / lang / lisp / stk-3.002 / stk-3 / STk-3.1 / INSTALL < prev    next >
Encoding:
Text File  |  1996-07-24  |  6.7 KB  |  181 lines
  1.             +----------------------------+
  2.             | STk 3.1 Installation notes |
  3.             +----------------------------+
  4.  
  5.  
  6. IMPORTANT NOTE - IMPORTANT NOTE - IMPORTANT NOTE
  7. ------------------------------------------------
  8. |  
  9. |  STk bignums are implemented with the GNU mp APIs. This library provides a 
  10. |  VERY EFFICIENT implementation of multiple precision numbers. This library 
  11. |  is placed under the GNU GENERAL PUBLIC LICENSE. However, to avoid to fall 
  12. |  under the restrictive GPL terms you can use the FGMP package (FGMP is a 
  13. |  public domain implementation of a subset of the GNU gmp library with the
  14. |  same API, written by Mark Henderson <markh@wimsey.bc.ca>). This package 
  15. |  has the advantage to be totally *FREE*, and the disadventage to be *SLOW*.
  16. |  
  17. |  So, if your concern is speed, and if the GPL is not a problem for you, 
  18. |  use the Gnu package.
  19. |
  20. |  Both package are in the distribution file. You don't need to ftp them.
  21. |
  22. ---------------------------------------------------------------------
  23. END OF IMPORTANT NOTE - END OF IMPORTANT NOTE - END OF IMPORTANT NOTE
  24.  
  25.  
  26. To install this package:
  27.  
  28. *** 1. Configure the package for your system.
  29.  
  30. In the directory  that this file is in, type 
  31.  
  32.     $ /bin/sh ./configure
  33.  
  34. This line runs the `configure' shell script. This script attempts to
  35. guess correct values for various system-dependent variables used
  36. during compilation, and creates various files necessary for package
  37. building.
  38.  
  39. Default configuration will compile the package with the the "gcc"
  40. compiler and the "-O2" option. This can be changed by changing the
  41. default value of the CC and CFLAGS shell variables. For instance:
  42.     
  43.      $ /bin/sh -c 'CC=another-cc CFLAGS="-O2 -g" ./configure'
  44.  
  45. will configure the package to use the "another-cc" compiler with
  46. options "-O2" and "-g".
  47.  
  48. By default, `make install' will install the package's files in
  49. /usr/local/bin, /usr/local/lib, /usr/local/man, etc.  You can specify
  50. an installation prefix other than /usr/local by giving `configure' the
  51. option `--prefix=PATH'. For instance to place everything in the
  52. directory whose name is 'another/place' You'll have to type
  53.  
  54.     $ /bin/sh configure --prefix=/another/place
  55.  
  56. By default STk is compiled with the Gnu MP library. If using GNU
  57. software is a problem for you you can specify to use the FGMP package
  58. with the '--with-fgmp' option. Example:
  59.     
  60.     $ /bin/sh configure --prefix=/another/place --with-fgmp
  61.  
  62. Several features can also specified at configuration time. To enable
  63. the feature XXX you'll have to specify the '--enable-XXX'. Of course,
  64. '--disable-XXX' permits to disable an option which is enabled by
  65. default. The following table gives the list of possible features
  66. available when compiling STk and their default value.
  67.  
  68.   ________________________________________________________________
  69.   | XXX        | Default |                      |
  70.   |        |  value  |                      |
  71.   |=============|=========|=======================================|
  72.   | hash    | enabled | Compile support for hash tables      |
  73.   |-------------|-------------------------------------------------|
  74.   | stklos    | enabled | Compile support for stklos (requires  |
  75.   |        |      | hash tables)              |
  76.   |-------------|---------|---------------------------------------|
  77.   | socket    | enabled | Compile support for sockets.      |
  78.   |-------------|-------------------------------------------------|
  79.   | dynload    | depends | Specifies if STk uses dynamic loading |
  80.   |        |      | for extensions. By default, dynamic      |
  81.   |        |      | loading is enabled for systems which  |
  82.   |        |      | support it (and for which support has |    
  83.   |        |      | been integrated into the interpreter  |
  84.   |        |      | This option permit to change this      |
  85.   |        |      | default value.              |
  86.   |        |      | See below for systems for which      |
  87.   |        |      | dynamic loading support exists      |
  88.   |-------------|-------------------------------------------------|
  89.   | elf        | depends | Use it to enable or disable ELF      |
  90.   |        |      | dynamic loading on Linux system.      |
  91.   |        |      | Default value is choosen by the      |
  92.   |        |      | configure script. If this value is      |
  93.   |        |      | incorrect, use this option to toggle  |
  94.   |        |      | it. This option works only on Linux      |
  95.   |        |      | systems                  |
  96.   |-------------|-------------------------------------------------|
  97.   | pixmap    [ enabled | Add pixmap support for Tk images      |
  98.   |        |      | Use --with-pixmap=XXX if configure      |
  99.   |        |      | can't locate your Xpm library. XXX      |
  100.   |        |      | is the linking option you need for      |
  101.   |        |      | using pixmaps. For example,          |
  102.   |        |      |   -with-pixmap='-L/home/X11 -lXpm'      |
  103.   |-------------|-------------------------------------------------|
  104.   | html    | enabled | Compile support for html          |
  105.   |-------------|-------------------------------------------------|
  106.   | dld        | disabled| Use it to enable synamic loading using|
  107.   |        |      | the DLD package (works on Linux only) |
  108.   |-------------|---------|---------------------------------------|
  109.   | regexp    | enabled | Add support for regular expressions      |
  110.   |-------------|---------|---------------------------------------|
  111.   | process    | enabled | Add support for running processes from|
  112.   |        |      | the interpreter and redirecting their |
  113.   |        |      | IO                      |
  114.   |-------------|---------|---------------------------------------|
  115.   | posix    | enabled | Add support for POSIX.1 functions.      |
  116.   |        |      | Support is very incmplete but will      |
  117.   |        |      | grow                  |
  118.   |_____________|_________|_______________________________________|
  119.               
  120. For instance
  121.  
  122.     $ /bin/sh -c 'CC=gcc ./configure --with-fgmp \
  123.               --enable-socket --prefix=/scheme'
  124.  
  125. will configure the package to use the free bignum library and the socket
  126. support . All the needed files will be installed in the /scheme/bin
  127. /scheme/lib ... directories.
  128.  
  129.  
  130. *** 2 . Compiling the package (and testing it)
  131.  
  132. Once configuration is done, just type 
  133.  
  134.     $ make
  135.  
  136. in this directory to make the whole system. Once the make is terminated you
  137. can do a minimal test of stk with
  138.  
  139.     $ (cd Src; /bin/sh test-stk)
  140.  
  141. This will bring a little squared window on your screen (if your DISPLAY
  142. variable is correctly set). When this is done, enter the following  line
  143.  
  144.     (pack (button '.test :text "Hello, world" :command '(destroy *root*)))
  145.  
  146. at the scheme prompt. This will display an Hello world button. Clicking on it 
  147. will leave the scheme interpreter. A more complete demo can be obtained with:
  148.     
  149.     $ make demos
  150.  
  151. This command runs the STk HTML browser on a file which allows you to launch
  152. simply the demos located in the "Demos" directory. 
  153.  
  154.  
  155.  
  156. *** 3. Documentation
  157.  
  158. Documentation is provided in Postscript and in TeX. To rebuild the
  159. documentation, you'll have to type
  160.     
  161.     $ make doc
  162.  
  163. This will rebuilt the Postscript documentation. To make only the 
  164. dvi files, use
  165.     
  166.     $ make dvi
  167.  
  168.  
  169. *** 4. Installation
  170.  
  171. To install stk in the definitive place, type
  172.  
  173.     $ make install
  174.  
  175. Intalling STk and Tk manual pages is done with
  176.  
  177.     $ make install.man
  178.  
  179. Have fun
  180.  
  181.